modelit.layout.Frame
Extends: modelit.layout.Node & hgsetget & handle & matlab.mixin.Heterogeneous
Properties
allowsChildren
True if the node is able to have children.
Boolean, default value: true
Help for modelit.layout.Frame/allowsChildren is inherited from superclass MODELIT.LAYOUT.NODE
children (Read-only)
Array of children,
May be [] if this node has no children.
Children are ordered according to their rank.
Array, default value: []
Help for modelit.layout.Frame/children is inherited from superclass MODELIT.LAYOUT.NODE
parent
This node's parent, or empty if this node has no parent.
modelit.layout.Node or [], default value: []
Help for modelit.layout.Frame/parent is inherited from superclass MODELIT.LAYOUT.NODE
rank
Relative position of the node
When ordering horizontally: low rank goes left. High rank goes right.
When ordering vertically. Low rank goes above. High rank goes below.
NOTE: only the relative ranks are important.
Integer, default value: 0
Help for modelit.layout.Frame/rank is inherited from superclass MODELIT.LAYOUT.NODE
Methods
splitFrame
Calculate position of frame.
CALL:
splitFrame(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
No direct output
ChildFrames:
sub-frames met bijgewerkte eigenschappen:
activenode
inborderpos
outborderpos
showslider:
true wanneer hoogte viewport<required
VERTICALSHIFT:
verticale verschuiving oiv slider
removeComponents
Removes all components in this frame.
CALL:
removeComponents(obj, excepted)
INPUT:
obj:
modelit.layout.Frame
excepted (optional, default value: []):
array with handles of components that should not be removed
OUTPUT:
No output
remove
Remove this frame from the tree.
CALL:
remove(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
No output
getComponentCount
Returns the number of components in this frame.
CALL:
value = getComponentCount(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
value:
integer with the number of components in this frame
getComponents
Returns this frame's components.
CALL:
value = getComponents(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
value:
list of handles with this frame's components.
ancestor
Returns the handle of the closest ancestor of the frame
that matches one of the types in type,
CALL:
p = ancestor(obj, type)
INPUT:
obj:
modelit.layout.Frame
type:
String or cell array of strings (types)
OUTPUT:
p:
handle of the closest ancestor of the frame that matches one of the types in type
getappdata
Get application data of this frame.
CALL:
value = getappdata(obj, property)
INPUT:
obj:
modelit.layout.Frame
property:
string of application data field
OUTPUT:
value:
application data stored in application data field
setappdata
Set application data of this frame.
CALL:
value = getappdata(obj, property)
INPUT:
obj:
modelit.layout.Frame
property:
string of application data field
value:
application data to be stored in application data field
OUTPUT:
No output
addComponent
Add a component to a modelit.layout.Frame
CALL:
addComponent(hframe, hobj, varargin)
INPUT:
hobj :
object or array of handles or jacontrol object
hframe:
frame to link to
property:
char string containg property name
value:
corresponding property value. Note: property/value
combinations may als be passed on as a tructure.
<propertye, value>
clipframe
see lm_resize
clipping [0 or 1]
clip object if out of frame borders
enable
Default: enable status is copied from application data
"enable" from frame.
Note
<on> and <off> is supported. <inactive> is not supported.
Object | Frame
enabled | enabled status
'Frame=on' 'Frame=off' 'Frame=inactive'
==========================================
0 ==> 'off' 'off' <not supported>
1 ==> 'on' 'off' <not supported>
2 ==> 'inactive' 'off' <not supported>
3 ==> 'off' 'off' <not supported>
4 ==> 'on' 'on' <not supported>
5 ==> 'inactive' 'inactive' <not supported>
keeppixelsize : is 1 maintain pixel height and width while alignigning in matrix
keepypos: if 1 ==> position of slider has no effect on this
object
normpos [X,Y,WIDTH,HEIGHT]
normalized position relative to LL corner of frame
pixelpos [X,Y,WIDTH,HEIGHT]
pixel position relative to LL corner of frame
visible
0 ==> do not show
1 ==> show
row: align on position (row,col) in matrix
col: align on position (row,col) in matrix
OUTPUT:
none
AFFECTED OBJECTS
-1- affected application data of frame:
when an object is linked to a frame, this will affect the following
fields of application data of this frame:
uichildren
textchildren
children
javachildren
-2- affected properties of object:
parent: when object-parent differs from frame-parent
units : set to "pixel" when object is of type
text,uicontainer,hgjavacomponent
-3- affected application data of object, required:
normpos
pixelpos
visible
enable
clipping
keepypos
-4- affected application data of object, optional:
clipframe
row
col
keeppixelsize
getClipRectangle
Compute clipping rectangle
CALL:
[fxmin, fxmax, fymin, fymax] = getClipRectangle(clipframe)
INPUT:
clipframe:
frames
borderpos
OUTPUT:
rect:
initializeTreetops
Initialise de variabele 'inborderpos' voor de frames die geen parent hebben
In tegenstelling tot frames met een parent, wordt hier de positie bepaald door
de elementen normpos en normpix, waarbij met broers en zussen geen rekening wordt gehouden
normpix wordt vermenigvuldigd met de afmetingen van het scherm
pixelsize wordt daarbij opgeteld
CALL:
[FrameData, hax] = initializeTreetops(FrameData, hfig)
INPUT:
FrameData:
modelit.layout.Frame
hfig:
handle of figure
OUTPUT:
FrameData:
hax:
plotFrame
Position and plot all components in this frame.
CALL:
plotFrame(frame)
INPUT:
frame:
modelit.layout.Frame
OUTPUT:
No output
updateHgProps
Update handle graphics properties of object and frame
hide
Hide all components and decorators of this frame
CALL:
hide(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
No output
if ~isempty(obj.exittext)
obj.exittext.visible = false;
paint(obj.exittext);
end
isActivenode
Determines if this node is active.
This method is use by the activenode property getter and can be overridden by subclasses.
CALL:
value = isActivenode(obj)
INPUT:
obj:
modelit.layout.Frame
OUTPUT:
value:
boolean, if true this frame if active (visible)
removeAll
Removes all components in this frame
CALL:
removeAll(obj)
INPUT:
obj:
modelit.layout.Frame
excepted (optional, default value: []):
array with handles of components that should not be removed
OUTPUT:
No output
find
Find a Frame with the specified tag
CALL:
h = find(tag, HWIN)
INPUT:
tag:
string with tag of Frame to look for
HWIN:
handle of figure in which to look for the Frame
OUTPUT:
h:
Array of modelit.layout.Frame, possible empty if no Frame with
specified tag exists
storeTree
Stores the tree (root node) in the specified figure
CALL:
layout = storeTree(HWIN)
INPUT:
HWIN:
handle of figure in which to store the tree.
layout:
modelit.layout.Frame with the root of the tree
OUTPUT:
No output
retrieveTree
Retrieves the tree (root node) from the specified figure
CALL:
layout = retrieveTree(HWIN)
INPUT:
HWIN:
handle of figure in which the tree is stored.
OUTPUT:
layout:
modelit.layout.Frame with the root of the tree
lm_get
Helper for migration to new layout manager
lm_set
Helper for migration to new layout manager
getPathToRoot
Builds the parents of node up to and including the root node, where the original node is the last element in the returned array.
CALL:
value = getPathToRoot(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
list of modelit.layout.Node
Help for modelit.layout.Frame/getPathToRoot is inherited from superclass MODELIT.LAYOUT.NODE
getLevel
Returns the number of levels above this node, i.e. the distance from the root to this node.
CALL:
value = getLevel(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
integer
Help for modelit.layout.Frame/getLevel is inherited from superclass MODELIT.LAYOUT.NODE
getDepthFirstList
First order for the subtree starting at the specified node.
CALL:
list = getDepthFirstList(obj, list)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
list:
array of modelit.layout.Node in depth-first order
Help for modelit.layout.Frame/getDepthFirstList is inherited from superclass MODELIT.LAYOUT.NODE
getBreadthFirstList
First order for the subtree starting at the specified node.
CALL:
list = getBreadthFirstList(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
list:
array of modelit.layout.Node in breadth-first order
Help for modelit.layout.Frame/getBreadthFirstList is inherited from superclass MODELIT.LAYOUT.NODE
getPreviousSibling
Returns the previous sibling of this node.
Returns [] if this node has no parent or if it is the parent's first child.
CALL:
value = getPreviousSibling(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
modelit.layout.Node or []
Help for modelit.layout.Frame/getPreviousSibling is inherited from superclass MODELIT.LAYOUT.NODE
getNextSibling
Returns the next sibling of this node.
Returns [] if this node has no parent or if it is the parent's last child.
CALL:
value = getNextSibling(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
modelit.layout.Node or []
Help for modelit.layout.Frame/getNextSibling is inherited from superclass MODELIT.LAYOUT.NODE
getSiblings
Gets the siblings (nodes with the same parent) of this node.
Note that this node is its own sibling
CALL:
value = getSiblings(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
modelit.layout.Node
Help for modelit.layout.Frame/getSiblings is inherited from superclass MODELIT.LAYOUT.NODE
removeAllChildren
Removes all of this node's children.
CALL:
removeAllChildren(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
No output
Help for modelit.layout.Frame/removeAllChildren is inherited from superclass MODELIT.LAYOUT.NODE
add
Removes newChild from its parent and makes it a child of this node by adding it to the end of this node's child array.
CALL:
add(obj, newChild)
INPUT:
obj:
modelit.layout.Node
newChild:
modelit.layout.Node, node to be added as a child of obj
OUTPUT:
No output
Help for modelit.layout.Frame/add is inherited from superclass MODELIT.LAYOUT.NODE
isRoot
Returns true if this node is the root of the tree.
CALL:
obj = isRoot(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
boolean, true if this node is a root node
Help for modelit.layout.Frame/isRoot is inherited from superclass MODELIT.LAYOUT.NODE
isLeaf
Returns true if this node is a leaf.
CALL:
value = isLeaf(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
boolean, true if this node is a leaf (has no children)
Help for modelit.layout.Frame/isLeaf is inherited from superclass MODELIT.LAYOUT.NODE
getRoot
Returns the root of this node.
CALL:
obj = getRoot(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
obj:
modelit.layout.Node
Help for modelit.layout.Frame/getRoot is inherited from superclass MODELIT.LAYOUT.NODE
getIndex
Returns the index of this node in its parent's children.
CALL:
value = getIndex(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
integer with index of this node in its parent's children, 0 if this node is a root
Help for modelit.layout.Frame/getIndex is inherited from superclass MODELIT.LAYOUT.NODE
getChildCount
Returns the number of children of this node.
CALL:
value = getChildCount(obj)
INPUT:
obj:
modelit.layout.Node
OUTPUT:
value:
integer with number of children of this node
Help for modelit.layout.Frame/getChildCount is inherited from superclass MODELIT.LAYOUT.NODE
getChildAt
Returns the child of obj at index childIndex.
CALL:
value = getChildAt(obj, childIndex)
INPUT:
obj:
modelit.layout.Node
childIndex:
integer
OUTPUT:
obj:
modelit.layout.Node or [] if index exceeds number of children
Help for modelit.layout.Frame/getChildAt is inherited from superclass MODELIT.LAYOUT.NODE
eq
Returns the objects whose property values match those passed as param-value pairs to the findobj command.
Help for modelit.layout.Frame/eq is inherited from superclass MODELIT.LAYOUT.NODE
findobj
Returns the objects whose property values match those passed as param-value pairs to the findobj command.
Help for modelit.layout.Frame/findobj is inherited from superclass MODELIT.LAYOUT.NODE